Advance Care Planning (PZP)
1.0.0 - release

This page is part of the Advance Care Planning (PZP) (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: ACP ContactPerson

Official URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-ContactPerson Version: 1.0.0
Draft as of 2026-08-11 Computable Name: ACPContactPerson

Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.

A person not being a healthcare professional who is involved in the patient’s care, such as family members, caregivers, mental caretakers, guardians and legal representatives. Based on nl-core-ContactPerson and HCIM ContactPerson.

Changes compared to nl-core

This profile adds ACP-specific mappings to the ART-DECOR dataset and obligation extensions for Provider and Consulter actors. Profile references are constrained to ACP profiles where available. The following change affects implementation beyond the base nl-core profile:

  • An additional slice .relationship:roleAdditional has been added, bound to ACPContactPersonRoleVS. This slice accommodates role codes required by the ACP dataset that are not included in the RolCodelijst bound to .relationship:role (e.g. SNOMED CT code 310141000146103 Schriftelijk gemachtigde zorg en behandeling, pre-adopted from the RolCodelijst in zib Contactpersoon v4.1 (2024)).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* NlcoreContactPerson Contact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... Slices for relationship Σ 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:$this
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... relationship:role SOΣ 0..* CodeableConcept Role
Binding: RolCodelijst (2020-09-01T00:00:00) (required): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:relationship SOΣ 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2020-09-01T00:00:00) (required): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:roleAdditional SOΣ 0..* CodeableConcept The nature of the relationship
Binding: ACPContactPersonRoleVS (1.0.0) (required)
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for name Σ 0..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation ΣC 0..2 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
..... use ?!SOΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... family ΣC 0..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... Slices for extension Content/Rules for all slices
....... extension:prefix SO 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName SO 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix SO 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName SO 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
..... given SOΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... Slices for extension Content/Rules for all slices
....... extension:givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
Constraints: ext-1
..... suffix SOΣ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... given SOΣ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... Slices for extension Content/Rules for all slices
...... extension:comment SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
..... system SOΣC 1..1 code TelecomType
Binding: ContactInformationTelephoneNumbersSystem (4.0.1) (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension Content/Rules for all slices
....... extension:telecomType SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
..... value SOΣ 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!SOΣ 0..1 code NumberType
Binding: ContactInformationTelephoneNumbersUse (4.0.1) (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... telecom:emailAddresses ΣC 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... system SOΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value SOΣ 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactInformationEmailAddressesUse (4.0.1) (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... Slices for extension Content/Rules for all slices
..... extension:addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
Constraints: ext-1
.... use ?!SOΣ 0..1 code AddressType
Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.
Example General: home
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type SOΣ 0..1 code AddressType
Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.
Example General: both
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... Slices for extension Content/Rules for all slices
...... extension:streetName SO 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] 1..1 string Street
...... extension:houseNumber SO 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition SO 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication SO 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] C 1..1 string HouseNumberIndication
Constraints: houseNumberIndication
...... extension:additionalInformation SO 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
....... value[x] 1..1 string AdditionalInformation
.... city SOΣ 0..1 string PlaceOfResidence
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district SOΣ 0..1 string Municipality
Example General: Madison
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... postalCode SOΣ 0..1 string Postcode
Example General: 9132
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... Slices for extension Content/Rules for all slices
...... extension:countryCode SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"

doco Documentation for this format
NameACP Actor ProviderACP Actor Consulterdoco
.. RelatedPerson
... patient
... Slices for relationship
.... relationship:role
.... relationship:relationship
.... relationship:roleAdditional
... Slices for name
.... name:nameInformation
..... Slices for extension
..... use
..... family
...... Slices for extension
....... extension:prefix
....... extension:lastName
....... extension:partnerPrefix
....... extension:partnerLastName
..... given
...... Slices for extension
..... suffix
.... name:nameInformation-GivenName
..... given
.... telecom:telephoneNumbers
..... Slices for extension
...... extension:comment
..... system
...... Slices for extension
....... extension:telecomType
..... value
..... use
.... telecom:emailAddresses
..... system
..... value
... address
.... Slices for extension
.... use
.... type
.... line
..... Slices for extension
...... extension:streetName
...... extension:houseNumber
...... extension:houseNumberLetter-houseNumberAddition
...... extension:houseNumberIndication
...... extension:additionalInformation
.... city
.... district
.... postalCode
.... country
..... Slices for extension
...... extension:countryCode

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.relationship:role Base required RolCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.relationship:relationship Base required RelatieCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.relationship:roleAdditional Base required ACP ContactPerson Role zib2024 backport 📍1.0.0 This IG
RelatedPerson.name:nameInformation.​extension:nameUsage.​value[x] Base required HumanNameAssemblyOrder 📍4.0.1 FHIR Std.
RelatedPerson.name:nameInformation.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.name:nameInformation-GivenName.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:telephoneNumbers.​system Base required ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:telephoneNumbers.​use Base required ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:emailAddresses.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:emailAddresses.​use Base required ContactPointUse ValueSet for zib ContactInformation EmailAddress 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address.​type Base required AddressType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddresses A system is required if a value is provided. value.empty() or system.exists()
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error RelatedPerson.implicitRules, RelatedPerson.modifierExtension, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.relationship, RelatedPerson.relationship:role, RelatedPerson.relationship:relationship, RelatedPerson.relationship:roleAdditional, RelatedPerson.name, RelatedPerson.name:nameInformation, RelatedPerson.name:nameInformation.extension:nameUsage, RelatedPerson.name:nameInformation.extension:nameUsage.value[x], RelatedPerson.name:nameInformation.use, RelatedPerson.name:nameInformation.family, RelatedPerson.name:nameInformation.family.extension:prefix, RelatedPerson.name:nameInformation.family.extension:prefix.value[x], RelatedPerson.name:nameInformation.family.extension:lastName, RelatedPerson.name:nameInformation.family.extension:lastName.value[x], RelatedPerson.name:nameInformation.family.extension:partnerPrefix, RelatedPerson.name:nameInformation.family.extension:partnerPrefix.value[x], RelatedPerson.name:nameInformation.family.extension:partnerLastName, RelatedPerson.name:nameInformation.family.extension:partnerLastName.value[x], RelatedPerson.name:nameInformation.given, RelatedPerson.name:nameInformation.given.extension, RelatedPerson.name:nameInformation.given.extension:givenOrInitial, RelatedPerson.name:nameInformation.suffix, RelatedPerson.name:nameInformation-GivenName, RelatedPerson.name:nameInformation-GivenName.use, RelatedPerson.name:nameInformation-GivenName.given, RelatedPerson.telecom, RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:telephoneNumbers.extension:comment, RelatedPerson.telecom:telephoneNumbers.system, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType, RelatedPerson.telecom:telephoneNumbers.value, RelatedPerson.telecom:telephoneNumbers.use, RelatedPerson.telecom:emailAddresses, RelatedPerson.telecom:emailAddresses.system, RelatedPerson.telecom:emailAddresses.value, RelatedPerson.telecom:emailAddresses.use, RelatedPerson.address, RelatedPerson.address.extension:addressType, RelatedPerson.address.use, RelatedPerson.address.type, RelatedPerson.address.line, RelatedPerson.address.line.extension:streetName, RelatedPerson.address.line.extension:streetName.value[x], RelatedPerson.address.line.extension:houseNumber, RelatedPerson.address.line.extension:houseNumber.value[x], RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition, RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition.value[x], RelatedPerson.address.line.extension:houseNumberIndication, RelatedPerson.address.line.extension:houseNumberIndication.value[x], RelatedPerson.address.line.extension:additionalInformation, RelatedPerson.address.line.extension:additionalInformation.value[x], RelatedPerson.address.city, RelatedPerson.address.district, RelatedPerson.address.postalCode, RelatedPerson.address.country, RelatedPerson.address.country.extension:countryCode All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RelatedPerson.modifierExtension, RelatedPerson.name:nameInformation.extension:nameUsage, RelatedPerson.name:nameInformation.family.extension:prefix, RelatedPerson.name:nameInformation.family.extension:lastName, RelatedPerson.name:nameInformation.family.extension:partnerPrefix, RelatedPerson.name:nameInformation.family.extension:partnerLastName, RelatedPerson.name:nameInformation.given.extension, RelatedPerson.name:nameInformation.given.extension:givenOrInitial, RelatedPerson.telecom:telephoneNumbers.extension:comment, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType, RelatedPerson.address.extension:addressType, RelatedPerson.address.line.extension:streetName, RelatedPerson.address.line.extension:houseNumber, RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition, RelatedPerson.address.line.extension:houseNumberIndication, RelatedPerson.address.line.extension:additionalInformation, RelatedPerson.address.country.extension:countryCode Must have either extensions or value[x], not both extension.exists() != value.exists()
houseNumberIndication error RelatedPerson.address.line.extension:houseNumberIndication.value[x] Must have value 'by' or 'to' $this in ('by' | 'to')
nl-core-NameInformation-01 warning RelatedPerson.name:nameInformation If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage. (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02 warning RelatedPerson.name:nameInformation.family If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage. (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
zib-NameInformation-1 error RelatedPerson.name:nameInformation If a prefix for a family name is specified, the family name is expected as well family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2 error RelatedPerson.name:nameInformation If the prefix for a partner family name is specified, the partner family name is expected as well family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* NlcoreContactPerson Contact
... patient SO 1..1 Reference(ACP Patient(1.0.0)) The patient this person is related to
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for relationship Content/Rules for all slices
.... relationship:role SO 0..* CodeableConcept Role
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:relationship SO 0..* CodeableConcept Relationship
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:roleAdditional SO 0..* CodeableConcept The nature of the relationship
Binding: ACPContactPersonRoleVS (1.0.0) (required)
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... name 0..* HumanName NameInformation / PayerName
.... name:nameInformation 0..2 NlcoreNameInformation NameInformation
..... use SO 1..1 code usual | official | temp | nickname | anonymous | old | maiden
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... family
...... Slices for extension Content/Rules for all slices
....... extension:prefix SO 0..1 OwnPrefix(5.2.0) Voorvoegsel derived from person's own surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension:lastName SO 0..1 OwnName(5.2.0) Portion derived from person's own surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension:partnerPrefix SO 0..1 PartnerPrefix(5.2.0) Voorvoegsel derived from person's partner's surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension:partnerLastName SO 0..1 PartnerName(5.2.0) Portion derived from person's partner's surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... given SO 0..* string FirstName / Initial
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... suffix SO 0..* string Titles
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... name:nameInformation-GivenName 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... given SO 1..* string GivenName
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... telecom 0..* ContactPoint ContactInformation
... Slices for telecom Content/Rules for all slices
.... telecom:telephoneNumbers 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
..... Slices for extension Content/Rules for all slices
...... extension:comment SO 0..1 ExtComment Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... system SO 1..1 code TelecomType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension Content/Rules for all slices
....... extension:telecomType SO 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value SO 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use SO 0..1 code NumberType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... telecom:emailAddresses 0..* NlcoreContactInformationEmailAddresses EmailAddresses
..... system SO 1..1 code email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value SO 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... address 0..* NlcoreAddressInformation AddressInformation
.... use SO 0..1 code AddressType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type SO 0..1 code AddressType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... line
..... Slices for extension Content/Rules for all slices
...... extension:streetName SO 0..1 ADXPStreetName(5.2.0) streetName
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension:houseNumber SO 0..1 ADXPHouseNumber(5.2.0) houseNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension:houseNumberLetter-houseNumberAddition SO 0..1 ADXPBuildingNumberSuffix(5.2.0) buildingNumberSuffix
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension:houseNumberIndication SO 0..1 ADXPAdditionalLocator(5.2.0) additionalLocator
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension:additionalInformation SO 0..1 ADXPUnitID(5.2.0) unitID
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... city SO 0..1 string PlaceOfResidence
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district SO 0..1 string Municipality
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... postalCode SO 0..1 string Postcode
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country
..... Slices for extension Content/Rules for all slices
...... extension:countryCode SO 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter

doco Documentation for this format
NameACP Actor ProviderACP Actor Consulterdoco
.. RelatedPerson
... patient
... Slices for relationship
.... relationship:role
.... relationship:relationship
.... relationship:roleAdditional
... Slices for name
.... name:nameInformation
..... use
..... family
...... Slices for extension
....... extension:prefix
....... extension:lastName
....... extension:partnerPrefix
....... extension:partnerLastName
..... given
..... suffix
.... name:nameInformation-GivenName
..... given
.... telecom:telephoneNumbers
..... Slices for extension
...... extension:comment
..... system
...... Slices for extension
....... extension:telecomType
..... value
..... use
.... telecom:emailAddresses
..... system
..... value
... address
.... use
.... type
.... line
..... Slices for extension
...... extension:streetName
...... extension:houseNumber
...... extension:houseNumberLetter-houseNumberAddition
...... extension:houseNumberIndication
...... extension:additionalInformation
.... city
.... district
.... postalCode
.... country
..... Slices for extension
...... extension:countryCode

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship:roleAdditional Base required ACP ContactPerson Role zib2024 backport 📍1.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* NlcoreContactPerson Contact
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient SOΣ 1..1 Reference(ACP Patient(1.0.0)) The patient this person is related to
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for relationship Σ 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:$this
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... relationship:role SOΣ 0..* CodeableConcept Role
Binding: RolCodelijst (2020-09-01T00:00:00) (required): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:relationship SOΣ 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2020-09-01T00:00:00) (required): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:roleAdditional SOΣ 0..* CodeableConcept The nature of the relationship
Binding: ACPContactPersonRoleVS (1.0.0) (required)
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for name Σ 0..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation ΣC 0..2 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
..... use ?!SOΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... text ΣC 0..1 string Text representation of the full name
..... family ΣC 0..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... Slices for extension Content/Rules for all slices
....... extension:prefix SO 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName SO 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix SO 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName SO 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given SOΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... Slices for extension Content/Rules for all slices
....... extension:givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
Constraints: ext-1
...... value 0..1 string Primitive value for string
Max Length:1048576
..... prefix Σ 0..* string Titles
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SOΣ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... period Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... given SOΣ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:comment SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string Comment
..... system SOΣC 1..1 code TelecomType
Binding: ContactInformationTelephoneNumbersSystem (4.0.1) (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... Slices for extension Content/Rules for all slices
....... extension:telecomType SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
........ value[x] 0..1 CodeableConcept TelecomType
Binding: TelecomTypeCodelijst (2020-09-01T00:00:00) (required)
...... value 0..1 string Primitive value for code
..... value SOΣ 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!SOΣ 0..1 code NumberType
Binding: ContactInformationTelephoneNumbersUse (4.0.1) (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses ΣC 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... system SOΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value SOΣ 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactInformationEmailAddressesUse (4.0.1) (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
Constraints: ext-1
.... use ?!SOΣ 0..1 code AddressType
Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.
Example General: home
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type SOΣ 0..1 code AddressType
Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.
Example General: both
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:streetName SO 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] 1..1 string Street
...... extension:houseNumber SO 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition SO 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication SO 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] C 1..1 string HouseNumberIndication
Constraints: houseNumberIndication
...... extension:additionalInformation SO 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
....... value[x] 1..1 string AdditionalInformation
..... value 0..1 string Primitive value for string
Max Length:1048576
.... city SOΣ 0..1 string PlaceOfResidence
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district SOΣ 0..1 string Municipality
Example General: Madison
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SOΣ 0..1 string Postcode
Example General: 9132
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:countryCode SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
....... value[x] 0..1 CodeableConcept Country
Binding: LandCodelijsten (2020-09-01T00:00:00) (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format
NameACP Actor ProviderACP Actor Consulterdoco
.. RelatedPerson
... patient
... Slices for relationship
.... relationship:role
.... relationship:relationship
.... relationship:roleAdditional
... Slices for name
.... name:nameInformation
..... Slices for extension
..... use
..... family
...... Slices for extension
....... extension:prefix
....... extension:lastName
....... extension:partnerPrefix
....... extension:partnerLastName
..... given
...... Slices for extension
..... suffix
.... name:nameInformation-GivenName
..... given
.... telecom:telephoneNumbers
..... Slices for extension
...... extension:comment
..... system
...... Slices for extension
....... extension:telecomType
..... value
..... use
.... telecom:emailAddresses
..... system
..... value
... address
.... Slices for extension
.... use
.... type
.... line
..... Slices for extension
...... extension:streetName
...... extension:houseNumber
...... extension:houseNumberLetter-houseNumberAddition
...... extension:houseNumberIndication
...... extension:additionalInformation
.... city
.... district
.... postalCode
.... country
..... Slices for extension
...... extension:countryCode

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.relationship:role Base required RolCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.relationship:relationship Base required RelatieCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.relationship:roleAdditional Base required ACP ContactPerson Role zib2024 backport 📍1.0.0 This IG
RelatedPerson.name:nameInformation.​extension:nameUsage.​value[x] Base required HumanNameAssemblyOrder 📍4.0.1 FHIR Std.
RelatedPerson.name:nameInformation.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.name:nameInformation-GivenName.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:telephoneNumbers.​system Base required ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:telephoneNumbers.​system.extension:telecomType.​value[x] Base required TelecomTypeCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:telephoneNumbers.​use Base required ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:emailAddresses.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:emailAddresses.​use Base required ContactPointUse ValueSet for zib ContactInformation EmailAddress 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address.​country.extension:countryCode.​value[x] Base required LandCodelijsten 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddresses A system is required if a value is provided. value.empty() or system.exists()
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error RelatedPerson.meta, RelatedPerson.implicitRules, RelatedPerson.language, RelatedPerson.text, RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.identifier, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.relationship, RelatedPerson.relationship:role, RelatedPerson.relationship:relationship, RelatedPerson.relationship:roleAdditional, RelatedPerson.name, RelatedPerson.name:nameInformation, RelatedPerson.name:nameInformation.extension, RelatedPerson.name:nameInformation.extension:nameUsage, RelatedPerson.name:nameInformation.extension:nameUsage.value[x], RelatedPerson.name:nameInformation.use, RelatedPerson.name:nameInformation.text, RelatedPerson.name:nameInformation.family, RelatedPerson.name:nameInformation.family.extension, RelatedPerson.name:nameInformation.family.extension:prefix, RelatedPerson.name:nameInformation.family.extension:prefix.value[x], RelatedPerson.name:nameInformation.family.extension:lastName, RelatedPerson.name:nameInformation.family.extension:lastName.value[x], RelatedPerson.name:nameInformation.family.extension:partnerPrefix, RelatedPerson.name:nameInformation.family.extension:partnerPrefix.value[x], RelatedPerson.name:nameInformation.family.extension:partnerLastName, RelatedPerson.name:nameInformation.family.extension:partnerLastName.value[x], RelatedPerson.name:nameInformation.given, RelatedPerson.name:nameInformation.given.extension, RelatedPerson.name:nameInformation.given.extension:givenOrInitial, RelatedPerson.name:nameInformation.prefix, RelatedPerson.name:nameInformation.suffix, RelatedPerson.name:nameInformation.period, RelatedPerson.name:nameInformation-GivenName, RelatedPerson.name:nameInformation-GivenName.extension, RelatedPerson.name:nameInformation-GivenName.use, RelatedPerson.name:nameInformation-GivenName.text, RelatedPerson.name:nameInformation-GivenName.given, RelatedPerson.name:nameInformation-GivenName.period, RelatedPerson.telecom, RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:telephoneNumbers.extension, RelatedPerson.telecom:telephoneNumbers.extension:comment, RelatedPerson.telecom:telephoneNumbers.extension:comment.extension, RelatedPerson.telecom:telephoneNumbers.extension:comment.value[x], RelatedPerson.telecom:telephoneNumbers.system, RelatedPerson.telecom:telephoneNumbers.system.extension, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.extension, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.value[x], RelatedPerson.telecom:telephoneNumbers.value, RelatedPerson.telecom:telephoneNumbers.use, RelatedPerson.telecom:telephoneNumbers.rank, RelatedPerson.telecom:telephoneNumbers.period, RelatedPerson.telecom:emailAddresses, RelatedPerson.telecom:emailAddresses.extension, RelatedPerson.telecom:emailAddresses.system, RelatedPerson.telecom:emailAddresses.value, RelatedPerson.telecom:emailAddresses.use, RelatedPerson.telecom:emailAddresses.rank, RelatedPerson.telecom:emailAddresses.period, RelatedPerson.gender, RelatedPerson.birthDate, RelatedPerson.address, RelatedPerson.address.extension, RelatedPerson.address.extension:addressType, RelatedPerson.address.use, RelatedPerson.address.type, RelatedPerson.address.text, RelatedPerson.address.line, RelatedPerson.address.line.extension, RelatedPerson.address.line.extension:streetName, RelatedPerson.address.line.extension:streetName.value[x], RelatedPerson.address.line.extension:houseNumber, RelatedPerson.address.line.extension:houseNumber.value[x], RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition, RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition.value[x], RelatedPerson.address.line.extension:houseNumberIndication, RelatedPerson.address.line.extension:houseNumberIndication.value[x], RelatedPerson.address.line.extension:additionalInformation, RelatedPerson.address.line.extension:additionalInformation.value[x], RelatedPerson.address.city, RelatedPerson.address.district, RelatedPerson.address.state, RelatedPerson.address.postalCode, RelatedPerson.address.country, RelatedPerson.address.country.extension, RelatedPerson.address.country.extension:countryCode, RelatedPerson.address.country.extension:countryCode.extension, RelatedPerson.address.country.extension:countryCode.value[x], RelatedPerson.address.period, RelatedPerson.photo, RelatedPerson.period, RelatedPerson.communication, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension, RelatedPerson.communication.language, RelatedPerson.communication.preferred All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.name:nameInformation.extension, RelatedPerson.name:nameInformation.extension:nameUsage, RelatedPerson.name:nameInformation.family.extension, RelatedPerson.name:nameInformation.family.extension:prefix, RelatedPerson.name:nameInformation.family.extension:lastName, RelatedPerson.name:nameInformation.family.extension:partnerPrefix, RelatedPerson.name:nameInformation.family.extension:partnerLastName, RelatedPerson.name:nameInformation.given.extension, RelatedPerson.name:nameInformation.given.extension:givenOrInitial, RelatedPerson.name:nameInformation-GivenName.extension, RelatedPerson.telecom:telephoneNumbers.extension, RelatedPerson.telecom:telephoneNumbers.extension:comment, RelatedPerson.telecom:telephoneNumbers.extension:comment.extension, RelatedPerson.telecom:telephoneNumbers.system.extension, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.extension, RelatedPerson.telecom:emailAddresses.extension, RelatedPerson.address.extension, RelatedPerson.address.extension:addressType, RelatedPerson.address.line.extension, RelatedPerson.address.line.extension:streetName, RelatedPerson.address.line.extension:houseNumber, RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition, RelatedPerson.address.line.extension:houseNumberIndication, RelatedPerson.address.line.extension:additionalInformation, RelatedPerson.address.country.extension, RelatedPerson.address.country.extension:countryCode, RelatedPerson.address.country.extension:countryCode.extension, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
houseNumberIndication error RelatedPerson.address.line.extension:houseNumberIndication.value[x] Must have value 'by' or 'to' $this in ('by' | 'to')
nl-core-NameInformation-01 warning RelatedPerson.name:nameInformation If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage. (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02 warning RelatedPerson.name:nameInformation.family If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage. (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
zib-NameInformation-1 error RelatedPerson.name:nameInformation If a prefix for a family name is specified, the family name is expected as well family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2 error RelatedPerson.name:nameInformation If the prefix for a partner family name is specified, the partner family name is expected as well family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
NameACP Actor ProviderACP Actor Consulterdoco
.. RelatedPerson
... patient
... Slices for relationship
.... relationship:role
.... relationship:relationship
.... relationship:roleAdditional
... Slices for name
.... name:nameInformation
..... Slices for extension
..... use
..... family
...... Slices for extension
....... extension:prefix
....... extension:lastName
....... extension:partnerPrefix
....... extension:partnerLastName
..... given
...... Slices for extension
..... suffix
.... name:nameInformation-GivenName
..... given
.... telecom:telephoneNumbers
..... Slices for extension
...... extension:comment
..... system
...... Slices for extension
....... extension:telecomType
..... value
..... use
.... telecom:emailAddresses
..... system
..... value
... address
.... Slices for extension
.... use
.... type
.... line
..... Slices for extension
...... extension:streetName
...... extension:houseNumber
...... extension:houseNumberLetter-houseNumberAddition
...... extension:houseNumberIndication
...... extension:additionalInformation
.... city
.... district
.... postalCode
.... country
..... Slices for extension
...... extension:countryCode

doco Documentation for this format

Summary

Must-Support: 30 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* NlcoreContactPerson Contact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... Slices for relationship Σ 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:$this
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... relationship:role SOΣ 0..* CodeableConcept Role
Binding: RolCodelijst (2020-09-01T00:00:00) (required): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:relationship SOΣ 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2020-09-01T00:00:00) (required): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:roleAdditional SOΣ 0..* CodeableConcept The nature of the relationship
Binding: ACPContactPersonRoleVS (1.0.0) (required)
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for name Σ 0..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation ΣC 0..2 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Constraints: ext-1
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
..... use ?!SOΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... family ΣC 0..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... Slices for extension Content/Rules for all slices
....... extension:prefix SO 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName SO 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix SO 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName SO 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
..... given SOΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... Slices for extension Content/Rules for all slices
....... extension:givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
Constraints: ext-1
..... suffix SOΣ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... given SOΣ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... Slices for extension Content/Rules for all slices
...... extension:comment SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
..... system SOΣC 1..1 code TelecomType
Binding: ContactInformationTelephoneNumbersSystem (4.0.1) (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension Content/Rules for all slices
....... extension:telecomType SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
..... value SOΣ 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!SOΣ 0..1 code NumberType
Binding: ContactInformationTelephoneNumbersUse (4.0.1) (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... telecom:emailAddresses ΣC 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... system SOΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value SOΣ 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactInformationEmailAddressesUse (4.0.1) (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... Slices for extension Content/Rules for all slices
..... extension:addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
Constraints: ext-1
.... use ?!SOΣ 0..1 code AddressType
Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.
Example General: home
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type SOΣ 0..1 code AddressType
Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.
Example General: both
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... Slices for extension Content/Rules for all slices
...... extension:streetName SO 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] 1..1 string Street
...... extension:houseNumber SO 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition SO 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication SO 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] C 1..1 string HouseNumberIndication
Constraints: houseNumberIndication
...... extension:additionalInformation SO 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
....... value[x] 1..1 string AdditionalInformation
.... city SOΣ 0..1 string PlaceOfResidence
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district SOΣ 0..1 string Municipality
Example General: Madison
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... postalCode SOΣ 0..1 string Postcode
Example General: 9132
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... Slices for extension Content/Rules for all slices
...... extension:countryCode SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"

doco Documentation for this format
NameACP Actor ProviderACP Actor Consulterdoco
.. RelatedPerson
... patient
... Slices for relationship
.... relationship:role
.... relationship:relationship
.... relationship:roleAdditional
... Slices for name
.... name:nameInformation
..... Slices for extension
..... use
..... family
...... Slices for extension
....... extension:prefix
....... extension:lastName
....... extension:partnerPrefix
....... extension:partnerLastName
..... given
...... Slices for extension
..... suffix
.... name:nameInformation-GivenName
..... given
.... telecom:telephoneNumbers
..... Slices for extension
...... extension:comment
..... system
...... Slices for extension
....... extension:telecomType
..... value
..... use
.... telecom:emailAddresses
..... system
..... value
... address
.... Slices for extension
.... use
.... type
.... line
..... Slices for extension
...... extension:streetName
...... extension:houseNumber
...... extension:houseNumberLetter-houseNumberAddition
...... extension:houseNumberIndication
...... extension:additionalInformation
.... city
.... district
.... postalCode
.... country
..... Slices for extension
...... extension:countryCode

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.relationship:role Base required RolCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.relationship:relationship Base required RelatieCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.relationship:roleAdditional Base required ACP ContactPerson Role zib2024 backport 📍1.0.0 This IG
RelatedPerson.name:nameInformation.​extension:nameUsage.​value[x] Base required HumanNameAssemblyOrder 📍4.0.1 FHIR Std.
RelatedPerson.name:nameInformation.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.name:nameInformation-GivenName.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:telephoneNumbers.​system Base required ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:telephoneNumbers.​use Base required ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:emailAddresses.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:emailAddresses.​use Base required ContactPointUse ValueSet for zib ContactInformation EmailAddress 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address.​type Base required AddressType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddresses A system is required if a value is provided. value.empty() or system.exists()
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error RelatedPerson.implicitRules, RelatedPerson.modifierExtension, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.relationship, RelatedPerson.relationship:role, RelatedPerson.relationship:relationship, RelatedPerson.relationship:roleAdditional, RelatedPerson.name, RelatedPerson.name:nameInformation, RelatedPerson.name:nameInformation.extension:nameUsage, RelatedPerson.name:nameInformation.extension:nameUsage.value[x], RelatedPerson.name:nameInformation.use, RelatedPerson.name:nameInformation.family, RelatedPerson.name:nameInformation.family.extension:prefix, RelatedPerson.name:nameInformation.family.extension:prefix.value[x], RelatedPerson.name:nameInformation.family.extension:lastName, RelatedPerson.name:nameInformation.family.extension:lastName.value[x], RelatedPerson.name:nameInformation.family.extension:partnerPrefix, RelatedPerson.name:nameInformation.family.extension:partnerPrefix.value[x], RelatedPerson.name:nameInformation.family.extension:partnerLastName, RelatedPerson.name:nameInformation.family.extension:partnerLastName.value[x], RelatedPerson.name:nameInformation.given, RelatedPerson.name:nameInformation.given.extension, RelatedPerson.name:nameInformation.given.extension:givenOrInitial, RelatedPerson.name:nameInformation.suffix, RelatedPerson.name:nameInformation-GivenName, RelatedPerson.name:nameInformation-GivenName.use, RelatedPerson.name:nameInformation-GivenName.given, RelatedPerson.telecom, RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:telephoneNumbers.extension:comment, RelatedPerson.telecom:telephoneNumbers.system, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType, RelatedPerson.telecom:telephoneNumbers.value, RelatedPerson.telecom:telephoneNumbers.use, RelatedPerson.telecom:emailAddresses, RelatedPerson.telecom:emailAddresses.system, RelatedPerson.telecom:emailAddresses.value, RelatedPerson.telecom:emailAddresses.use, RelatedPerson.address, RelatedPerson.address.extension:addressType, RelatedPerson.address.use, RelatedPerson.address.type, RelatedPerson.address.line, RelatedPerson.address.line.extension:streetName, RelatedPerson.address.line.extension:streetName.value[x], RelatedPerson.address.line.extension:houseNumber, RelatedPerson.address.line.extension:houseNumber.value[x], RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition, RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition.value[x], RelatedPerson.address.line.extension:houseNumberIndication, RelatedPerson.address.line.extension:houseNumberIndication.value[x], RelatedPerson.address.line.extension:additionalInformation, RelatedPerson.address.line.extension:additionalInformation.value[x], RelatedPerson.address.city, RelatedPerson.address.district, RelatedPerson.address.postalCode, RelatedPerson.address.country, RelatedPerson.address.country.extension:countryCode All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RelatedPerson.modifierExtension, RelatedPerson.name:nameInformation.extension:nameUsage, RelatedPerson.name:nameInformation.family.extension:prefix, RelatedPerson.name:nameInformation.family.extension:lastName, RelatedPerson.name:nameInformation.family.extension:partnerPrefix, RelatedPerson.name:nameInformation.family.extension:partnerLastName, RelatedPerson.name:nameInformation.given.extension, RelatedPerson.name:nameInformation.given.extension:givenOrInitial, RelatedPerson.telecom:telephoneNumbers.extension:comment, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType, RelatedPerson.address.extension:addressType, RelatedPerson.address.line.extension:streetName, RelatedPerson.address.line.extension:houseNumber, RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition, RelatedPerson.address.line.extension:houseNumberIndication, RelatedPerson.address.line.extension:additionalInformation, RelatedPerson.address.country.extension:countryCode Must have either extensions or value[x], not both extension.exists() != value.exists()
houseNumberIndication error RelatedPerson.address.line.extension:houseNumberIndication.value[x] Must have value 'by' or 'to' $this in ('by' | 'to')
nl-core-NameInformation-01 warning RelatedPerson.name:nameInformation If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage. (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02 warning RelatedPerson.name:nameInformation.family If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage. (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
zib-NameInformation-1 error RelatedPerson.name:nameInformation If a prefix for a family name is specified, the family name is expected as well family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2 error RelatedPerson.name:nameInformation If the prefix for a partner family name is specified, the partner family name is expected as well family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* NlcoreContactPerson Contact
... patient SO 1..1 Reference(ACP Patient(1.0.0)) The patient this person is related to
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for relationship Content/Rules for all slices
.... relationship:role SO 0..* CodeableConcept Role
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:relationship SO 0..* CodeableConcept Relationship
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:roleAdditional SO 0..* CodeableConcept The nature of the relationship
Binding: ACPContactPersonRoleVS (1.0.0) (required)
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... name 0..* HumanName NameInformation / PayerName
.... name:nameInformation 0..2 NlcoreNameInformation NameInformation
..... use SO 1..1 code usual | official | temp | nickname | anonymous | old | maiden
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... family
...... Slices for extension Content/Rules for all slices
....... extension:prefix SO 0..1 OwnPrefix(5.2.0) Voorvoegsel derived from person's own surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension:lastName SO 0..1 OwnName(5.2.0) Portion derived from person's own surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension:partnerPrefix SO 0..1 PartnerPrefix(5.2.0) Voorvoegsel derived from person's partner's surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... extension:partnerLastName SO 0..1 PartnerName(5.2.0) Portion derived from person's partner's surname
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... given SO 0..* string FirstName / Initial
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... suffix SO 0..* string Titles
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... name:nameInformation-GivenName 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... given SO 1..* string GivenName
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... telecom 0..* ContactPoint ContactInformation
... Slices for telecom Content/Rules for all slices
.... telecom:telephoneNumbers 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
..... Slices for extension Content/Rules for all slices
...... extension:comment SO 0..1 ExtComment Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... system SO 1..1 code TelecomType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... Slices for extension Content/Rules for all slices
....... extension:telecomType SO 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value SO 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use SO 0..1 code NumberType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... telecom:emailAddresses 0..* NlcoreContactInformationEmailAddresses EmailAddresses
..... system SO 1..1 code email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value SO 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... address 0..* NlcoreAddressInformation AddressInformation
.... use SO 0..1 code AddressType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type SO 0..1 code AddressType
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... line
..... Slices for extension Content/Rules for all slices
...... extension:streetName SO 0..1 ADXPStreetName(5.2.0) streetName
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension:houseNumber SO 0..1 ADXPHouseNumber(5.2.0) houseNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension:houseNumberLetter-houseNumberAddition SO 0..1 ADXPBuildingNumberSuffix(5.2.0) buildingNumberSuffix
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension:houseNumberIndication SO 0..1 ADXPAdditionalLocator(5.2.0) additionalLocator
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... extension:additionalInformation SO 0..1 ADXPUnitID(5.2.0) unitID
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... city SO 0..1 string PlaceOfResidence
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district SO 0..1 string Municipality
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... postalCode SO 0..1 string Postcode
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country
..... Slices for extension Content/Rules for all slices
...... extension:countryCode SO 0..1 ExtCodeSpecification Optional Extensions Element
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter

doco Documentation for this format
NameACP Actor ProviderACP Actor Consulterdoco
.. RelatedPerson
... patient
... Slices for relationship
.... relationship:role
.... relationship:relationship
.... relationship:roleAdditional
... Slices for name
.... name:nameInformation
..... use
..... family
...... Slices for extension
....... extension:prefix
....... extension:lastName
....... extension:partnerPrefix
....... extension:partnerLastName
..... given
..... suffix
.... name:nameInformation-GivenName
..... given
.... telecom:telephoneNumbers
..... Slices for extension
...... extension:comment
..... system
...... Slices for extension
....... extension:telecomType
..... value
..... use
.... telecom:emailAddresses
..... system
..... value
... address
.... use
.... type
.... line
..... Slices for extension
...... extension:streetName
...... extension:houseNumber
...... extension:houseNumberLetter-houseNumberAddition
...... extension:houseNumberIndication
...... extension:additionalInformation
.... city
.... district
.... postalCode
.... country
..... Slices for extension
...... extension:countryCode

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedPerson.relationship:roleAdditional Base required ACP ContactPerson Role zib2024 backport 📍1.0.0 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* NlcoreContactPerson Contact
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient SOΣ 1..1 Reference(ACP Patient(1.0.0)) The patient this person is related to
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for relationship Σ 0..* CodeableConcept The nature of the relationship
Slice: Unordered, Open by value:$this
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... relationship:role SOΣ 0..* CodeableConcept Role
Binding: RolCodelijst (2020-09-01T00:00:00) (required): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:relationship SOΣ 0..* CodeableConcept Relationship
Binding: RelatieCodelijst (2020-09-01T00:00:00) (required): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... relationship:roleAdditional SOΣ 0..* CodeableConcept The nature of the relationship
Binding: ACPContactPersonRoleVS (1.0.0) (required)
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
... Slices for name Σ 0..* HumanName NameInformation / PayerName
Slice: Unordered, Open by value:use
.... name:nameInformation ΣC 0..2 NlcoreNameInformation NameInformation
Constraints: zib-NameInformation-1, zib-NameInformation-2, nl-core-NameInformation-01
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:nameUsage 0..1 (Complex) Preferred display order of name parts
URL: http://hl7.org/fhir/StructureDefinition/humanname-assembly-order
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order"
....... value[x] 1..1 code NameUsage
Binding: HumanNameAssemblyOrder (required): Use ConceptMap NaamgebruikCodelijst-to-HumanNameAssemblyOrder to translate terminology from the functional model to profile terminology in ValueSet HumanNameAssemblyOrder.
..... use ?!SOΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: official
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... text ΣC 0..1 string Text representation of the full name
..... family ΣC 0..1 string Family name (often called 'Surname')
Constraints: nl-core-NameInformation-02
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... Slices for extension Content/Rules for all slices
....... extension:prefix SO 0..1 (Complex) Voorvoegsel derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"
........ value[x] 1..1 string Prefix
....... extension:lastName SO 0..1 (Complex) Portion derived from person's own surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-own-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-own-name"
........ value[x] 1..1 string LastName
....... extension:partnerPrefix SO 0..1 (Complex) Voorvoegsel derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix"
........ value[x] 1..1 string PartnerPrefix
....... extension:partnerLastName SO 0..1 (Complex) Portion derived from person's partner's surname
URL: http://hl7.org/fhir/StructureDefinition/humanname-partner-name
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
........ value[x] 1..1 string PartnerLastName
...... value 0..1 string Primitive value for string
Max Length:1048576
..... given SOΣC 0..* string FirstName / Initial
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... Slices for extension Content/Rules for all slices
....... extension:givenOrInitial 1..* code LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
URL: http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier
Binding: EntityNamePartQualifier (required)
Constraints: ext-1
...... value 0..1 string Primitive value for string
Max Length:1048576
..... prefix Σ 0..* string Titles
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix SOΣ 0..* string Titles
This repeating element order: Suffixes appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... period Σ 0..1 Period Time period when name was/is in use
.... name:nameInformation-GivenName Σ 0..* NlcoreNameInformationGivenName Name of a human - parts and usage
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... use ?!Σ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Required Pattern: usual
..... text Σ 0..1 string Text representation of the full name
..... given SOΣ 1..* string GivenName
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom Σ 0..* ContactPoint ContactInformation
Slice: Unordered, Open by profile:$this
.... telecom:telephoneNumbers ΣC 0..* NlcoreContactInformationTelephoneNumbers TelephoneNumbers
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... Slices for extension Content/Rules for all slices
...... extension:comment SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-Comment"
....... value[x] 0..1 string Comment
..... system SOΣC 1..1 code TelecomType
Binding: ContactInformationTelephoneNumbersSystem (4.0.1) (required): Use ConceptMap TelecomType-to-ContactInformation-TelephoneNumbersSystem to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersSystem.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... Slices for extension Content/Rules for all slices
....... extension:telecomType SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
........ url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
........ value[x] 0..1 CodeableConcept TelecomType
Binding: TelecomTypeCodelijst (2020-09-01T00:00:00) (required)
...... value 0..1 string Primitive value for code
..... value SOΣ 0..1 string TelephoneNumber
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!SOΣ 0..1 code NumberType
Binding: ContactInformationTelephoneNumbersUse (4.0.1) (required): Use ConceptMap NummerSoortCodelijst-to-ContactInformation-TelephoneNumbersUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-TelephoneNumbersUse.
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:emailAddresses ΣC 0..* NlcoreContactInformationEmailAddresses EmailAddresses
Constraints: cpt-2
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... system SOΣC 1..1 code email
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... value SOΣ 0..1 string EmailAddress
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
..... use ?!Σ 0..1 code EmailAddressType
Binding: ContactInformationEmailAddressesUse (4.0.1) (required): Use ConceptMap EmailSoortCodelijst-to-ContactInformation-EmailAddressesUse to translate terminology from the functional model to profile terminology in ValueSet ContactInformation-EmailAddressesUse.
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address Σ 0..* NlcoreAddressInformation AddressInformation
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:addressType N 0..1 CodeableConcept Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-AddressInformation.AddressType
Binding: AdresSoortCodelijst (extensible)
Constraints: ext-1
.... use ?!SOΣ 0..1 code AddressType
Binding: AddressUse (required): Use ConceptMap AdresSoortCodelijst-to-AddressUse to translate terminology from the functional model to profile terminology in ValueSet AddressUse.
Example General: home
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... type SOΣ 0..1 code AddressType
Binding: AddressType (required): Use ConceptMap AdresSoortCodelijst-to-AddressType to translate terminology from the functional model to profile terminology in ValueSet AddressType.
Example General: both
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:streetName SO 0..1 (Complex) streetName
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName"
....... value[x] 1..1 string Street
...... extension:houseNumber SO 0..1 (Complex) houseNumber
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber"
....... value[x] 1..1 string HouseNumber
...... extension:houseNumberLetter-houseNumberAddition SO 0..1 (Complex) buildingNumberSuffix
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix"
....... value[x] 1..1 string HouseNumberLetter / HouseNumberAddition
...... extension:houseNumberIndication SO 0..1 (Complex) additionalLocator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator"
....... value[x] C 1..1 string HouseNumberIndication
Constraints: houseNumberIndication
...... extension:additionalInformation SO 0..1 (Complex) unitID
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID"
....... value[x] 1..1 string AdditionalInformation
..... value 0..1 string Primitive value for string
Max Length:1048576
.... city SOΣ 0..1 string PlaceOfResidence
Example General: Erewhon
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... district SOΣ 0..1 string Municipality
Example General: Madison
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode SOΣ 0..1 string Postcode
Example General: 9132
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:countryCode SO 0..1 (Complex) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification
Constraints: ext-1
ObligationsActor
SHALL:populate-if-known ACP Actor Provider
SHALL:no-error ACP Actor Consulter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification"
....... value[x] 0..1 CodeableConcept Country
Binding: LandCodelijsten (2020-09-01T00:00:00) (required)
..... value 0..1 string Primitive value for string
Max Length:1048576
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format
NameACP Actor ProviderACP Actor Consulterdoco
.. RelatedPerson
... patient
... Slices for relationship
.... relationship:role
.... relationship:relationship
.... relationship:roleAdditional
... Slices for name
.... name:nameInformation
..... Slices for extension
..... use
..... family
...... Slices for extension
....... extension:prefix
....... extension:lastName
....... extension:partnerPrefix
....... extension:partnerLastName
..... given
...... Slices for extension
..... suffix
.... name:nameInformation-GivenName
..... given
.... telecom:telephoneNumbers
..... Slices for extension
...... extension:comment
..... system
...... Slices for extension
....... extension:telecomType
..... value
..... use
.... telecom:emailAddresses
..... system
..... value
... address
.... Slices for extension
.... use
.... type
.... line
..... Slices for extension
...... extension:streetName
...... extension:houseNumber
...... extension:houseNumberLetter-houseNumberAddition
...... extension:houseNumberIndication
...... extension:additionalInformation
.... city
.... district
.... postalCode
.... country
..... Slices for extension
...... extension:countryCode

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.relationship:role Base required RolCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.relationship:relationship Base required RelatieCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.relationship:roleAdditional Base required ACP ContactPerson Role zib2024 backport 📍1.0.0 This IG
RelatedPerson.name:nameInformation.​extension:nameUsage.​value[x] Base required HumanNameAssemblyOrder 📍4.0.1 FHIR Std.
RelatedPerson.name:nameInformation.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.name:nameInformation-GivenName.​use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.telecom:telephoneNumbers.​system Base required ContactPointSystem ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:telephoneNumbers.​system.extension:telecomType.​value[x] Base required TelecomTypeCodelijst 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:telephoneNumbers.​use Base required ContactPointUse ValueSet for zib ContactInformation TelephoneNumbers 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.telecom:emailAddresses.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
RelatedPerson.telecom:emailAddresses.​use Base required ContactPointUse ValueSet for zib ContactInformation EmailAddress 📍4.0.1 FHIR implementation of zibs 2020 v0.12
RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
RelatedPerson.address.​use Base required AddressUse 📍4.0.1 FHIR Std.
RelatedPerson.address.​type Base required AddressType 📍4.0.1 FHIR Std.
RelatedPerson.address.​country.extension:countryCode.​value[x] Base required LandCodelijsten 📍2020-09-01T00:00:00 FHIR implementation of zibs 2020 v0.12
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpt-2 error RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:emailAddresses A system is required if a value is provided. value.empty() or system.exists()
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error RelatedPerson.meta, RelatedPerson.implicitRules, RelatedPerson.language, RelatedPerson.text, RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.identifier, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.relationship, RelatedPerson.relationship:role, RelatedPerson.relationship:relationship, RelatedPerson.relationship:roleAdditional, RelatedPerson.name, RelatedPerson.name:nameInformation, RelatedPerson.name:nameInformation.extension, RelatedPerson.name:nameInformation.extension:nameUsage, RelatedPerson.name:nameInformation.extension:nameUsage.value[x], RelatedPerson.name:nameInformation.use, RelatedPerson.name:nameInformation.text, RelatedPerson.name:nameInformation.family, RelatedPerson.name:nameInformation.family.extension, RelatedPerson.name:nameInformation.family.extension:prefix, RelatedPerson.name:nameInformation.family.extension:prefix.value[x], RelatedPerson.name:nameInformation.family.extension:lastName, RelatedPerson.name:nameInformation.family.extension:lastName.value[x], RelatedPerson.name:nameInformation.family.extension:partnerPrefix, RelatedPerson.name:nameInformation.family.extension:partnerPrefix.value[x], RelatedPerson.name:nameInformation.family.extension:partnerLastName, RelatedPerson.name:nameInformation.family.extension:partnerLastName.value[x], RelatedPerson.name:nameInformation.given, RelatedPerson.name:nameInformation.given.extension, RelatedPerson.name:nameInformation.given.extension:givenOrInitial, RelatedPerson.name:nameInformation.prefix, RelatedPerson.name:nameInformation.suffix, RelatedPerson.name:nameInformation.period, RelatedPerson.name:nameInformation-GivenName, RelatedPerson.name:nameInformation-GivenName.extension, RelatedPerson.name:nameInformation-GivenName.use, RelatedPerson.name:nameInformation-GivenName.text, RelatedPerson.name:nameInformation-GivenName.given, RelatedPerson.name:nameInformation-GivenName.period, RelatedPerson.telecom, RelatedPerson.telecom:telephoneNumbers, RelatedPerson.telecom:telephoneNumbers.extension, RelatedPerson.telecom:telephoneNumbers.extension:comment, RelatedPerson.telecom:telephoneNumbers.extension:comment.extension, RelatedPerson.telecom:telephoneNumbers.extension:comment.value[x], RelatedPerson.telecom:telephoneNumbers.system, RelatedPerson.telecom:telephoneNumbers.system.extension, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.extension, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.value[x], RelatedPerson.telecom:telephoneNumbers.value, RelatedPerson.telecom:telephoneNumbers.use, RelatedPerson.telecom:telephoneNumbers.rank, RelatedPerson.telecom:telephoneNumbers.period, RelatedPerson.telecom:emailAddresses, RelatedPerson.telecom:emailAddresses.extension, RelatedPerson.telecom:emailAddresses.system, RelatedPerson.telecom:emailAddresses.value, RelatedPerson.telecom:emailAddresses.use, RelatedPerson.telecom:emailAddresses.rank, RelatedPerson.telecom:emailAddresses.period, RelatedPerson.gender, RelatedPerson.birthDate, RelatedPerson.address, RelatedPerson.address.extension, RelatedPerson.address.extension:addressType, RelatedPerson.address.use, RelatedPerson.address.type, RelatedPerson.address.text, RelatedPerson.address.line, RelatedPerson.address.line.extension, RelatedPerson.address.line.extension:streetName, RelatedPerson.address.line.extension:streetName.value[x], RelatedPerson.address.line.extension:houseNumber, RelatedPerson.address.line.extension:houseNumber.value[x], RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition, RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition.value[x], RelatedPerson.address.line.extension:houseNumberIndication, RelatedPerson.address.line.extension:houseNumberIndication.value[x], RelatedPerson.address.line.extension:additionalInformation, RelatedPerson.address.line.extension:additionalInformation.value[x], RelatedPerson.address.city, RelatedPerson.address.district, RelatedPerson.address.state, RelatedPerson.address.postalCode, RelatedPerson.address.country, RelatedPerson.address.country.extension, RelatedPerson.address.country.extension:countryCode, RelatedPerson.address.country.extension:countryCode.extension, RelatedPerson.address.country.extension:countryCode.value[x], RelatedPerson.address.period, RelatedPerson.photo, RelatedPerson.period, RelatedPerson.communication, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension, RelatedPerson.communication.language, RelatedPerson.communication.preferred All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.name:nameInformation.extension, RelatedPerson.name:nameInformation.extension:nameUsage, RelatedPerson.name:nameInformation.family.extension, RelatedPerson.name:nameInformation.family.extension:prefix, RelatedPerson.name:nameInformation.family.extension:lastName, RelatedPerson.name:nameInformation.family.extension:partnerPrefix, RelatedPerson.name:nameInformation.family.extension:partnerLastName, RelatedPerson.name:nameInformation.given.extension, RelatedPerson.name:nameInformation.given.extension:givenOrInitial, RelatedPerson.name:nameInformation-GivenName.extension, RelatedPerson.telecom:telephoneNumbers.extension, RelatedPerson.telecom:telephoneNumbers.extension:comment, RelatedPerson.telecom:telephoneNumbers.extension:comment.extension, RelatedPerson.telecom:telephoneNumbers.system.extension, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType, RelatedPerson.telecom:telephoneNumbers.system.extension:telecomType.extension, RelatedPerson.telecom:emailAddresses.extension, RelatedPerson.address.extension, RelatedPerson.address.extension:addressType, RelatedPerson.address.line.extension, RelatedPerson.address.line.extension:streetName, RelatedPerson.address.line.extension:houseNumber, RelatedPerson.address.line.extension:houseNumberLetter-houseNumberAddition, RelatedPerson.address.line.extension:houseNumberIndication, RelatedPerson.address.line.extension:additionalInformation, RelatedPerson.address.country.extension, RelatedPerson.address.country.extension:countryCode, RelatedPerson.address.country.extension:countryCode.extension, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
houseNumberIndication error RelatedPerson.address.line.extension:houseNumberIndication.value[x] Must have value 'by' or 'to' $this in ('by' | 'to')
nl-core-NameInformation-01 warning RelatedPerson.name:nameInformation If parts of the name are specified using one or more of the structured elements, the `.text` element SHOULD be populated with a rendered version of the full name. This ensures compatibility with common FHIR usage. (family.exists() or given.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier').where(value != 'IN').exists()) implies text.hasValue()
nl-core-NameInformation-02 warning RelatedPerson.name:nameInformation.family If parts of the family name are specified using the extensions in .family, the .family element SHOULD be populated with the full family name as well. This ensures compatibility with common FHIR usage. (extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').exists() or extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').exists()) implies $this.hasValue()
zib-NameInformation-1 error RelatedPerson.name:nameInformation If a prefix for a family name is specified, the family name is expected as well family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not()
zib-NameInformation-2 error RelatedPerson.name:nameInformation If the prefix for a partner family name is specified, the partner family name is expected as well family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not()
NameACP Actor ProviderACP Actor Consulterdoco
.. RelatedPerson
... patient
... Slices for relationship
.... relationship:role
.... relationship:relationship
.... relationship:roleAdditional
... Slices for name
.... name:nameInformation
..... Slices for extension
..... use
..... family
...... Slices for extension
....... extension:prefix
....... extension:lastName
....... extension:partnerPrefix
....... extension:partnerLastName
..... given
...... Slices for extension
..... suffix
.... name:nameInformation-GivenName
..... given
.... telecom:telephoneNumbers
..... Slices for extension
...... extension:comment
..... system
...... Slices for extension
....... extension:telecomType
..... value
..... use
.... telecom:emailAddresses
..... system
..... value
... address
.... Slices for extension
.... use
.... type
.... line
..... Slices for extension
...... extension:streetName
...... extension:houseNumber
...... extension:houseNumberLetter-houseNumberAddition
...... extension:houseNumberIndication
...... extension:additionalInformation
.... city
.... district
.... postalCode
.... country
..... Slices for extension
...... extension:countryCode

doco Documentation for this format

Summary

Must-Support: 30 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron